#region (c) 2014 THN Solutions LLC. - All rights reserved
/*
THN WEB SERVER

Copyright (c) 2014, THN Solutions LLC. ( www.ThnSolutions.com )
Author: Nguyễn, M. Hải                 ( www.Minh-Hai.com     )
All rights reserved.

This library is dual-licensed.
  + For use in commercial software, please obtain a commercial license from THN Solutions LLC.    

  + For use in free software, this library is licensed under GPL version 3. A summary of 
	GPLv3 is listed below. You should also find a copy of GPLv3 as file License_GPLv3.txt 
	included with the source-code files.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 3 as published by
    the Free Software Foundation  of the License.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
#endregion

#region Record of Change
//             							CHANGE HISTORY
// -------------------------------------------------------------------------------------
// |   DATE    | DEVELOPER  | DESCRIPTION                                              |
// -------------------------------------------------------------------------------------
// | 16-Nov-12 | HaiNM      | First creation.                                          |
// -------------------------------------------------------------------------------------
//
#endregion

#region Record of Audit
//             							REVIEW HISTORY
// -------------------------------------------------------------------------------------
// |   DATE    | REVIEWER   | NOTES                                                    |
// -------------------------------------------------------------------------------------
// -------------------------------------------------------------------------------------
//
#endregion

#region Using directives
using System;

using Thn;
#endregion

namespace Thn.Web
{
    /// <summary>
    /// 
    /// </summary>
#if DEBUG || TESTING
    public
#else
    public
#endif
    interface IFileResource
    {
        /// <summary>
        /// Gets the URI of this resource.
        /// </summary>
        string Uri
        { get; }

        /// <summary>
        /// Gets the total number of bytes this resource occupies.
        /// </summary>
        long Size
        { get; }

        /// <summary>
        /// Gets the last time this resource was modified.
        /// </summary>
        DateTime LastModified
        { get; }

        /// <summary>
        /// Gets an ETag represents this resource' latest version.
        /// </summary>
        string ETag
        { get; }

        #region Read
        /// <summary>
        /// Attempt to read a number of bytes from the desired file into the target buffer.
        /// </summary>
        /// <param name="buffer">The buffer to contain the data read.</param>
        /// <param name="fileOffset">Zero-based location from the beginning of file.</param>
        /// <param name="bytesToRead">Number of bytes to be read.</param>
        /// <param name="actualBytesRead">Number of bytes actually read.</param>
        /// <returns>Status of this operation.</returns>
        FileReadStatus Read(byte[] buffer, long fileOffset, int bytesToRead, out int actualBytesRead);
        #endregion
    }
}
